--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
vendor/lxmfy/docs/README.md fee9e3356259c967b89373cf94deec01e6a5e6b3 (fee9e335) Text, 1.95 KB
LXMFy Docs
Docs for the LXMFy bot framework. Built using Sphinx and Furo theme.
Building
T282828
poetry install --with dev
T8b949e# Build English documentation (HTML, EPUB, PDF, Text)
make html
make epub
make latexpdf
make text
T8b949e# Build Russian documentation
make html-ru
make epub-ru
make latexpdf-ru
make text-ru
T8b949e# Build documentation for any language (replace XX with language code)
make html-XX epub-XX latexpdf-XX text-XX
T8b949e# Build all formats for all languages (English + all in locales/)
T8b949e# The Gitea Actions CI does this automatically
Running
T282828
make serve
Docker
Local/Development (BusyBox)
T282828
docker build -t lxmfy-docs .
docker run -p T79c0ff8080:8080 lxmfy-docs
Production (Nginx)
T282828
docker build -f Dockerfile.prod -t lxmfy-docs:prod .
docker run -p T79c0ff8080:8080 lxmfy-docs:prod
If using Podman, replace T383838docker with T383838podman.
Translations
How to Add or Update Translations
1. Generate translation templates:
T282828
make pot
2. For a new language (e.g., T383838fr for French):
T282828
T8b949e# Create directory structure
mkdir -p locales/fr/LC_MESSAGES
T8b949e# Copy and rename template files
cp build/gettext/*.pot locales/fr/LC_MESSAGES/
rename Ta5d6ff's/\.pot$/.po/' locales/fr/LC_MESSAGES/*.pot
T8b949e# Translate the msgstr fields in the .po files
3. For existing languages (update translations):
T282828
T8b949e# Edit locales/*/LC_MESSAGES/*.po files to update translations
4. Build the translated documentation:
T282828
T8b949e# Build all formats for your language (replace XX with language code)
make html-XX epub-XX latexpdf-XX text-XX
T8b949e# Gitea Actions automatically builds all languages and formats
Note: The system automatically detects all languages in T383838locales/ and builds all formats for them. Adding a new language requires only creating the translation files - no workflow changes needed!
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────